ngbe-1.2.7(release time: 2025/07/15)
[Bug]
- fix bug that PPS width macro value in configure file is not correctly parsed and computed in driver code.  
  [Impact scenarios]:
  The unit of PPS width in configure file is ms. the driver should convert it to ns units firstly.
  [severity]: high 

- fix bug that ethtool cannot show port mode correctly when yt8521s/yt8531s phy is in utp mode. [jira:EMERALDSW-358]
  [Impact scenarios]:
  When yt8521s/yt8531s external phy is used and the phy is in utp mode or combo mode with utp port linked up, 
  ethtool shows the port mode as fiber which is not correct.
  [severity]: low
  
- fix bug that ethtool shows rtl8211 phy link speed as 10M occasionally, which is not the real link speed.[jira:EMERALDSW-362]
  [Impact scenarios]:
  When rtl8211 external phy is used, ethtool shows link speed as 10M occasionally, while the real link speed is 1000M. This is
  caused by driver checking uncorrectable link speed register.   
  [severity]: high 
  
- fix bug that if number of ports on the machine is greater than 32 or unbinding/binding the port which causes number of created ports to 33
  there's out of range calltrace printed.  [jira: SAP-328]
  [Impact scenarios]:
  If there're more than 32 wx1860 ethernet ports on a single machine or repeatedly unbinding and binding ports up to 33 times, 
  newer kernel versions with the UBSAN component will report the call trace. 
  This is caused by an out-of-bound access in the RSS array defined in driver code.
  [severity]: low

- fix bug that if the tx vlan offload is turned off,  the double vlan packets cannot be sent successfully.
  [Impact scenarios]:
  Running iperf to send double vlan packets would fail when tx vlan offload is turned off.
  [severity]: high

- fix bug that when an 802.1ad packet with checksum error is received, rx_csum_offload_errors stat value is not increased.[jira:SAP-298]
  [severity]: middle
  
- fix bug that "ethtool dev" does not show "Wake-on" status correctly. [jira:EMERALDSW-364]
  [Impact scenarios]:
  "ethtool dev" always shows "Wake-on" as "g" which means the card supports wol even if the card does not support wol indeed. 
  [severity]: middle

- fix bug on kunpeng920. On kunpeng920, smmu would report event 0x10 occasionally if smmu is on.
  The packet data would be tampered with occasionally if smmu is off. [jira:SAP-343,SAP-344]
  [Impact scenarios]:
  On kunpeng920, smmu would report event 0x10 occasionally if smmu is on. 
  The packet data would be tampered with occasionally if smmu is off.
  These two issues are both caused by hw pcie read request completion out of order.
  [severity]: high

- fix bug that fw reset will cause driver to do re-initiation.[jira:EMERALDSW-366]
  [Impact scenarios]:
  Fw will do reset in some conditions. It will cause driver to do re-initiation and print "Reset Adapter" message.
  It will lead traffic be cut off for a while.
  [severity]: high

- fix bug that unloading xsk program may lead calltrace [jira: AMLITE-399]
  [Impact scenarios]:
  Unloading the xsk program while there's still traffic would cause kernel call trace.
  [severity]: middle

- fix bug that if lldp is set, following the steps:  ifconfig down->unplug the cable->ifconfig up->plug in the cable,
  the link status is no. [EMERALDSW-367]
  [severity]:low
 
- fix bug that driver may maintain uncorrect lldp on/off status if bmc or wxtool changes the lldp status.
  [Impact scenarios]: 
  The driver only get fw lldp status at intialization time. If bmc or wxtool changes the lldp status after that, 
  the driver possibly goes to uncorrect flow according to wrong lldp status. This may lead to link cannot be up. 
  [severity]: high
 
- fix bug that when yt8521/8531 external phy is used and CONFIG_DEBUG_SPINLOCK is set in kernel, there's calltrace printed.[jira:EMERALDSW-368]
  [Impact scenarios]:
  When kernel sets CONFIG_DEBUG_SPINLOCK, the kernel will dump calltrace in driver intialization time with yt phy card.
  [severity]: low

- fix bug that double vlan packet sent by vf cannot work when port vlan offload is enabled. [jira: SAP-339]
  [Impact scenarios]:
  execute following commands:
  1. ip link set ethx vf [vf_index] vlan [vlanid1]
  2. ip link add vlan.vlanid1 link ethx type vlan id [vlanid2]
  the vf cannot send double vlan packet correctly. 
  [severity: high]
  
- fix bug that "ethtool -s" can set invalid speed without error promoted.[jira:EMERALDSW-371] 
  [Impact scenarios]:
  when executing "ethtool -s dev speed 101(any invalid num) duplex full autoneg on",
  ethtool will not return error but show unknown speed and link status down.
  Add check to return error under this case.
  [severity: low]
  
- fix bug that executing xdp_redirect may cause calltrace [jira: EMERALDSW-376]
  [Impact scenarios]:
  When executing xdp_redirect, there's calltrace dump.
  [severity: middle] 

- fix bug that cannot get phy id when the external phy is yt8521/8531 and the fw is ncsi valid.  
  [Impact scenarios]:
  May occasionally cannot get yt phy id since fw is accessing phy at the same time.
  [severity: low]
  
- fix bug that link up message is reported after the high-temperature alarm [jira: EMERALDSW-375]
  [Impact scenarios]:
  when the high-temperature alarm is triggered, there's link up message printed. It should not be reported in such situation.
  [severity: low]
  
- fix bug that VF multicast address removal does not take effect[EMERALDSW-380]
  [Impact scenarios]:
  VF continues receving traffic with removed mulicast addresses.
  [severity: high]

  
[New feature]
- add new ethtool stats [jira:EMERALDSW-349]
  show rdb packets count, rdb drop count, parser count, tdm count, tdm drop count, tdb count, parser drop count,
  linksec untag packets, rx mac packets in ethtool stats, and print packets when rx_err msglvl is enabled.

- add support to desc check  [jira:EMERALDSW-350]
  enable desc check and desc error interrupt.
  enable dumping rings and skbs when tx hangs or pcie request error occurs.

- add support for phy 88e1111 or similar models to 88e1111.
  this feature needs mix phy type supported firmware.

- add 100M link speed support for yt8011a [jira:EMERALDSW-361]

- add support for enabling vf link state
  add support for command "ip link set dev vf n state enable" 

- add generated.sh file for cross compiling and compiling into kernel.

- add the capability to map non-linear xdp frames in XDP_TX and ndo_xdp_xmit callback. [jira: EMERALDSW-378]

- update pci.updates file according to the latest version of pci.ids. [jira:SAP-307]
  
[Optimization]
- always power up phy at hw intialization. Add phy resume function for external phys. [jira: EMERALDSW-369]

ngbe-1.2.6.5(release time: 2024/12/27)
- fix compile error on redhat-9.5 uos-1070
- fix compile error when kernel set CONFIG_MODULE_SIG_FORCE

ngbe-1.2.6.4(release time: 2024/9/19)
- optimize reset flow when driver is tx hang or timeout
- fix handling of NAPI budget when multiple queues are enabled per vector
- fix resolving ipv6 packet header errors
- fix tunnel packets unreachable when enable sriov

ngbe-1.2.6.3(release time: 2024/9/11)
- fix tx csum offload except tcp udp sctp l4 protocol

ngbe-1.2.6.2(release time: 2024/8/19)
- add HAVE_NETDEV_XMIT_MORE macro to avoid redefintion of netdev_xmit_more in kylin_v10 4.19.90.
- fix Kylin-Server-V10-SP3-2403 OS compiling errors.

ngbe-1.2.6.1(release time: 2024/06/13)
- fix bug: when netdev_uc_addr is more than 16, it do not open promisc mode correct.
- fix bug: Hardware only support max request size 128.

known unresolved issues:
1. UOS 1050a, log "RXDCTL.ENABLE on Rx queue 0 not cleared within the polling period" happens probabilistically. [EMERALDSW-265]

ngbe-1.2.6(release time: 2024/04/12)
- add support for inspur ncsi card
- add AER error type debug information
- add support for yutai phy unidirectional mode. add driver load params to enable/disable the unidirectional mode.
- add support for phy JL2201-N048C
- add support for phy rtl8211f
- add support for phy XZP211FS
- add support for phy yt8531h
- add support for showing fw version on vf by "ethtool -i vf_port_name"
- add support for dynamic itr configuration and adaptive rx usecs by command "ethtool -C" 
- add support for vf trust function.
- add support for setting vf vlan type of 802.1ad 
  by command "ip link set [pf_name] vf [vf_id] vlan [vlan_id] proto 802.1ad"
- add cpu architecture or pcie upstream type check to determine whether to do pcie recovery when there's pcie error.
- add support for setting the vf link state by command "ip link set [pf_name] vf [vf_id] state disable/auto"
- set gpio0 to input direction mode by default.
- remove the restriction that vf mtu can be greater than 1500 only when pf mtu is greater than 1500
- add mbx cmd to let driver get lldp on/off status from fw.
- change hw feature "rx-vlan-filter" in command "ethtool -k" to be configurable. Change "tx-vlan-stag-hw-insert" and
  "rx-vlan-stag-hw-parse" in "ethtool -k" to be fixed.
- add support for notifying firmware the link status change when the card has smbus function.
- add support for redhat8.3 and 8.9.
- add support for openEuler20.03SP4
- fix bug: when install vf driver by using "make modules_install" and then create vfs of all the ports successively, 
           there will be problem with getting mailbox lock.
- fix bug: failed to execute command "ip link add <vlan_name> link <vf_name> device type vlan id <vlan_id>"
           after command "ip link set <pf_name> vf <vf_num> vlan <vlan_id>" 
- fix bug: yt8531sh-ca phy can't be powered down in combo mode. This bug only exists in -ca chip version.
- fix bug: when phy is external phy, vf driver cannot get the link status.
- fix bug: when promisc mode is enabled, vlan packets cannot be received.
- fix bug: the rx multicat statistics of pf is not correct when vfs are enabled.
- fix bug: When enable SRIOV, the bug "unable to handle kernel NULL pointer" will occasionally happen.
- fix bug: when using "ethtool -X ethx hkey" to set RSS hash key, the command does not take effect. 
- fix bug: yt8531s-ca can't generate interrupt in combo mode.
- fix bug for xdp:
  The statistics of queues 4 to 7 are lost after xdp program is loaded.
  There's xdp_redirect drop error in some kernel version.
- features change in xdp:
  delete save ring states when xdp load and unload
  add xsk support
  allow to increase mtu to 3K with xdp enabled
  when executing "ethtool -L" to set the number of normal rings, the number of xdp rings are not changed.

known unresolved issues:
1. UOS 1050a, log "RXDCTL.ENABLE on Rx queue 0 not cleared within the polling period" happens probabilistically. [EMERALDSW-265]

ngbe-1.2.5.3(release time: 2023/11/17)
- add support for vpd update when using "ethtool -f" to upgrade flash image
- add support for kernel 6.4.0

known unresolved issues:
1. UOS 1050a, log "RXDCTL.ENABLE on Rx queue 0 not cleared within the polling period" happens probabilistically. [EMERALDSW-265]
2. VF can not obtain mailbox lock when PF does down/up. [EMERALDSW-266]
3. The statistics of queues 4 to 7 are lost after xdp program is loaded. [EMERALDSW-267]

ngbe-1.2.5.2(release time: 2023/11/13)
- fix bug that "ifconfig down" would not power down the external phy\

known unresolved issues:
1. UOS 1050a, log "RXDCTL.ENABLE on Rx queue 0 not cleared within the polling period" happens probabilistically. [EMERALDSW-265]
2. VF can not obtain mailbox lock when PF does down/up. [EMERALDSW-266]
3. The statistics of queues 4 to 7 are lost after xdp program is loaded. [EMERALDSW-267]

ngbe-1.2.5(release time: 2023/07/11)
- fix bug in ECC error recovery flow. Change the device reset waiting time from 3s to 1s
- fix bug when the flash cannot be accessed, getting lldp status from flash would take too long time at driver loading time. 
  It will cause cpu stucked.
- fix bug when pf link is down, vf cannot detect the link change.
- fix bug that makes ethtool show advertised speed abnormal in autoneg off case.
- fix bug: the number of descriptors in tx/rx queue must be multiple of 128.
- To avoid the speed of internal phy from 1000M down to 100M/10M when signal is not good, set "disable fall 100M" bit of gphy reg.
- To avoid the speed of internal phy from 1000M down to 100M/10M when signal is not good, driver will retry auto-negotiation for 3 times 
  if gphy does not link to 1000m. This action can be switch on/off by macro and is off by default.
- Make "Disable completion timeout" macro on by default.
- change yt8521/8531 BMCR from 0x8240 t0 0x8140 in 1G autoneg off case. 
- do not do pcie hot reset when pcie error found if sriov is enabled.
- Add ngbe genphy_suspend and genphy_resume ops. Change flow of gphy initialization, only setup phy power in ngbe_probe
->ngbe_phy_init. When ngbe_open/close, just to phy_suspend and phy_resume.
- optimize the driver code.
- add support for KylinV10 Desktop 
- add support for suse15sp5, suse15.5
- add support for redhat9.2, redhat 8.8
- add support for fedora38
- add support for uos server 1060a,1060e
- new feature: add XDP support:
  - Xdp programs can be loaded in native mode
  - Supports XDP_PASS, XDP_DROP, XDP_ABORTED, XDP_TX, XDP_REDIRECT xdp action
  - Supports load AF_XDP in copy-mode
  - Supports AF_XDP loaded on a specified queue

known unresolved issues:
1. UOS 1050a, log "RXDCTL.ENABLE on Rx queue 0 not cleared within the polling period" happens probabilistically. [EMERALDSW-265]
2. VF can not obtain mailbox lock when PF does down/up. [EMERALDSW-266]
3. The statistics of queues 4 to 7 are lost after xdp program is loaded. [EMERALDSW-267]

ngbe-1.2.4(release time: 2023/03/01)
- fix bug on concurrent accessing to yutai phy registers. Add spinlock for protection.
- fix bug that when double vlan hw offload is on, iperf cannot send/recevie packets successfully.
- fix bug that when enable sriov mode with 7 vfs, an error "free already-free IRQ" would be promoted by os.
- fix bug that the max number of RSS queue pairs exceeded the number of cpu cores.
- fix bug that executing "make modules_install" does not depmod in some kinds of linux os.
- fix bug on statistical count of "rx_missed_errors".
- fix bug that vf works abnormal in promisc mode.
- fix bug that if mac address is changed by host,default mac address cannot be restored after driver reload when hw veto bit is set.
- Do sw reset instead of pcie recovery flow when hw ecc error reported.
- regroup pcie aer status register print information. 
- regroup NGBE_FLAG2_PCIE_NEED_RECOVER macro. remove unused NGBE_PCIE_RECOVER macro
- add ncsi support on yutai phy.
- add auto-negotiation on/off switch for yutai phy in 001 mode.
- add PCIe registers print infomation for debugging when detecting pcie pending bit not clear issue.
- add lan reset in tx timeout / clean tx irq flow
- add "enable/disable lldp offload in fw" by using ethtool
- add support for KylinV10_x86_testv3, KylinV10 sp1 and sp2
- add support for ubuntu14.04
- add support for redhat8.7 and 9.1
- add support for sles12.3, 15.4 and 12

ngbe-1.2.3(release time: 2022/08/16)
- remove zte phy related code.
- fix bug of identifing the real phy mode when in marvell phy mix mode.
- fix bug that speed change would lead to link down in marvell phy copper mode.
- add support for marvell/yt8521 1000base-x mode autoneg on/off switch by ethtool
- turn off fiber auto sensing and set 1000BX manually to avoid link to 100M occationally in yt8521/8531 fiber mode
- add support for yt8521/8531 "sgmii mac-to-rgmii phy" mode
- add spinlock protection on yt8521/8531 phy ext field registers accessing
- add pcie aer configuration space print info before pcie recovery
- add marcro switches NGBE_RECOVER_CHECK and NGBE_DIS_COMP_TIMEOUT in configure file
- correct the link mode showing by "ethtool dev" when phy is in fiber mode 
- add support for x86 centos8.6 and centos 9.0
- add support for linux kernel 5.18.1
- add support for openEuler 22.03 and uos ulec20
- add support for openEuler 4.19.208  
- change the compile parameter
- fix bug that lan0 would ocassionally fail to initialize when insmod driver imediately after rmmod driver
- add support for updating initramfs in Makefile
- when using "ethtool -f" to upgrade flash image, the operation can only be made once before reboot the machine. 
- add chip version(A/B) check when using "ethtool -f" 
- disable gphy green ethernet
- disable gphy eee

known unresolved issues:
1. double vlan and QinQ can cause call trace and do pcie recovery
2. On loongson platform, mac_ctl packets can cause call trace
3. Sometimes, 'ethtool -s ethx autoneg on' is not valid on yt8521 phy

ngbe-1.2.2(release time: 2022/04/12)
- fix bug of pcie recovery flow. 
  Also add pcie recovery switch in configure file to turn on/off this function
- fix bug that phy speed auto-negotiation will occasionally set speed to 100M while 
  1000M is what we really want
- add speed auto-negotiation retry for internel phy 
  if the speed is linked to 100M while 1000M is what we really want.
  Also, add speed auto-negotiation retry switch to turn on/off this function
- add support for yt8531 phy
- add support for yt8521/8531 SGMAC_TO_RGPHY(3'b101) mode
- add support for customerize oem ssid and svid.
- add support for suse15sp3, suse12sp5, suse11.3 
- add support for ubuntu21.10
- add support for arm/x86 centos8.5
- add support for centos7.3-7.6

ngbe-1.2.1(release time: 2021/12/20)
- add support for ssid xx62 and xx64 for yt_phy_sfp which can control the tx laser of sfp module by gpio
- fix compile warnning
- fix bug of 'ethtool -p' for yt8521 phy with some old kernel

ngbe-1.2.0(release time: 2021/11/29)
- fix bug of sending udp packet out-of-order
- fix compiling error on kernel-realtime os 
- fix compiling error when DISABLE_PACKET_SPLIT macro is switched on.
- fix efuse configuration bug.4
- fix bug of showing correct suppported link speed when executing "ethtool ethName" 
- fix compiling error on centos4.18.0 rt7
- add support for "internal phy-to-yt8521" mode
- add support for "rgmii mac to FPGA" mode
- add support for yt8521 "rgmii mac to sgmii phy" mode
- add support for setting force speed to 1000M/100M/10M when yt8521 is in utp mode
  with ethtool command.
- add support for led and polarity configuration in firmware.
  supported phy type:
  -internal phy
  -marvell88E1512
  -yt8521
- add marvell88E1512 phy power on/off action when making lan port up/down.
- add support for selectable fiber/rj45 mode of marvell 88e1512 for each lan port on one chip
- add support for "ethtool -p" with marvell 88e1512 phy.
- fix bug of tunnel mode traffic such as vxlan

Note:
current version supports "ethtool -p" function. However, it has some restrictions.
1. For yt8521 phy, "ethtool -p" would make led2 blink. If you do not use led2, this 
command has no effect.


ngbe-1.1.1(release time: 2021/11/29)
- add phy force-speed mode to autoneg off cmd
- add ethtool -p for yt8521 phy
- add yt8521 link status polling mode
- diff yt8521 utp and fiber mode in "ethtool name" command 
- add itr setting configuration in configure file
- fix compling bugs in kernel 5.10 and centos 8.4
- fix sriov issue to make sure sriov cannot be disabled when vfs are assigned.

ngbe-1.1.0(release time: 2021/05/21)
- fix polling bond mode speed 100 not link up
- fix tx pending bit when fw is 10008/10009
- fix ethtool -a xxx autoneg on failed
- fix when hy guest os is windows bar4 will be clean 



ngbe-1.0.9(release time: 2021/04/20)
- ethtool -t xxx 
- add mbox check
- fix ngbevf autoload error 
- update to support kernel 5.8.9
- compile in centos 8.3
- fix phy signal set bug
- uprade img function



ngbe-1.0.8(release time: 2021/01/22)
- support pcie error recovery 
- add sub device id 0x0103
- add poll link status method to accelerate bond switch speed.
- add support for "ethtool -k rxhash off/on"
- fix compile error on uos ft platform.
- fix "ethtool -p xxx" function bug
- add switch control for yutai phy power.
- fix multicast packet bug 

issues exist in current version:
- iperf udp/tcp traffic has problem in double vlan mode. 



Driver version: 1.0.0(beta)

Supported OS: CentOS 7.2 to 7.4 and kylinft

=================================================================================

Contents
--------

- Important Notes
- Supported Features
- Hardware Supported Hardware
- Known Issues and Workarounds
- Building and Installation:
- Command Line Parameters

=================================================================================

Important Notes:
----------------

This is the first released version of Wangxun gigabit ethernet driver. It is fully new and still remain in
debugging status.

Supported Features:
-------------
- Support 10/100/1000M full and Autoneg.
- Support Legacy/MSI/MSI-X interrupt.
- Support ipv4/ipv6, Support promisc mode.
- Support RSS.
- Support Vlan.
- Support Tx/Rx checksum offload.
- Support TSO.
- Support Jumbo Frames.
- Support IEEE 1588.
- Support Linux bond.
- Support L2 Filter.

Supported Hardware:
-----------------------
- for internal phy only.
- compatible for PCIE gen2 x4.

Known Issues and Workarounds:
-----------------------------
functions below is still debugging:
- Wake-On-LAN
- SR-IOV
- Flow control
- PXE

Building and Installation:
--------------------------

to build ngbe, install kernel-header and kernel-devel packages corresponding to kernel version(command: uname -r).
then contact to us and get driver tgz file, uncompress tgz, go to src directory.
you can
in x86 platform:
compile the driver by executing "make"
install the driver by executing "make install"
in kylinft platform:
compile the driver by executing "make kylinft"
install the driver by executing "make kylinft_install"
load driver by executing "modprobe ngbe" or "modprobe ngbe [parameter=port1_value,port2_value]"
unload driver by executing "rmmod ngbe"

Command Line Parameters:
------------------------

Use ethtool, ifconfig, or ip link * to set or get the driver information, see man of these tools.


=================================================================================





